<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstNetControlMessageMeta: GStreamer 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-net.html" title="GStreamer Network Classes">
<link rel="prev" href="GstNetClientClock.html" title="GstNetClientClock">
<link rel="next" href="gstreamer-libs-GstNetTimePacket.html" title="GstNetTimePacket">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gstreamer-libs-GstNetControlMessageMeta.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gstreamer-net.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstNetClientClock.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gstreamer-libs-GstNetTimePacket.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gstreamer-libs-GstNetControlMessageMeta"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gstreamer-libs-GstNetControlMessageMeta.top_of_page"></a>GstNetControlMessageMeta</span></h2>
<p>GstNetControlMessageMeta — Network Control Message Meta</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gstreamer-libs-GstNetControlMessageMeta.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#GstNetControlMessageMeta" title="struct GstNetControlMessageMeta"><span class="returnvalue">GstNetControlMessageMeta</span></a> *
</td>
<td class="function_name">
<a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#gst-buffer-add-net-control-message-meta" title="gst_buffer_add_net_control_message_meta ()">gst_buffer_add_net_control_message_meta</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#gst-buffer-get-net-control-message-meta" title="gst_buffer_get_net_control_message_meta()">gst_buffer_get_net_control_message_meta</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../html/gstreamer-GstMeta.html#GstMetaInfo"><span class="returnvalue">GstMetaInfo</span></a> *
</td>
<td class="function_name">
<a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#gst-net-control-message-meta-get-info" title="gst_net_control_message_meta_get_info ()">gst_net_control_message_meta_get_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gstreamer-libs-GstNetControlMessageMeta.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#GstNetControlMessageMeta" title="struct GstNetControlMessageMeta">GstNetControlMessageMeta</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gstreamer-libs-GstNetControlMessageMeta.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gst/net/net.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="gstreamer-libs-GstNetControlMessageMeta.description"></a><h2>Description</h2>
<p><a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#GstNetControlMessageMeta" title="struct GstNetControlMessageMeta"><span class="type">GstNetControlMessageMeta</span></a> can be used to store control messages (ancillary
data) which was received with or is to be sent alongside the buffer data.
When used with socket sinks and sources which understand this meta it allows
sending and receiving ancillary data such as unix credentials (See
<a href="/usr/share/gtk-doc/html/gio/GUnixCredentialsMessage.html#GUnixCredentialsMessage-struct"><span class="type">GUnixCredentialsMessage</span></a>) and Unix file descriptions (See <a href="/usr/share/gtk-doc/html/gio/GUnixFDMessage.html#GUnixFDMessage-struct"><span class="type">GUnixFDMessage</span></a>).</p>
</div>
<div class="refsect1">
<a name="gstreamer-libs-GstNetControlMessageMeta.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-buffer-add-net-control-message-meta"></a><h3>gst_buffer_add_net_control_message_meta ()</h3>
<pre class="programlisting"><a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#GstNetControlMessageMeta" title="struct GstNetControlMessageMeta"><span class="returnvalue">GstNetControlMessageMeta</span></a> *
gst_buffer_add_net_control_message_meta
                               (<em class="parameter"><code><a href="../html/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a> *buffer</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GSocketControlMessage.html#GSocketControlMessage-struct"><span class="type">GSocketControlMessage</span></a> *message</code></em>);</pre>
<p>Attaches <em class="parameter"><code>message</code></em>
 as metadata in a <a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#GstNetControlMessageMeta" title="struct GstNetControlMessageMeta"><span class="type">GstNetControlMessageMeta</span></a> to <em class="parameter"><code>buffer</code></em>
.</p>
<div class="refsect3">
<a name="gst-buffer-add-net-control-message-meta.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>a <a href="../html/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>a <em class="parameter"><code>GSocketControlMessage</code></em>
to attach to <em class="parameter"><code>buffer</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gst-buffer-add-net-control-message-meta.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="gstreamer-libs-GstNetControlMessageMeta.html#GstNetControlMessageMeta" title="struct GstNetControlMessageMeta"><span class="type">GstNetControlMessageMeta</span></a> connected to <em class="parameter"><code>buffer</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gst-buffer-get-net-control-message-meta"></a><h3>gst_buffer_get_net_control_message_meta()</h3>
<pre class="programlisting">#define             gst_buffer_get_net_control_message_meta(b)</pre>
</div>
<hr>
<div class="refsect2">
<a name="gst-net-control-message-meta-get-info"></a><h3>gst_net_control_message_meta_get_info ()</h3>
<pre class="programlisting">const <a href="../html/gstreamer-GstMeta.html#GstMetaInfo"><span class="returnvalue">GstMetaInfo</span></a> *
gst_net_control_message_meta_get_info (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="gstreamer-libs-GstNetControlMessageMeta.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstNetControlMessageMeta"></a><h3>struct GstNetControlMessageMeta</h3>
<pre class="programlisting">struct GstNetControlMessageMeta {
  GstMeta       meta;

  GSocketControlMessage *message;
};
</pre>
<p>Buffer metadata for GSocket control messages, AKA ancillary data attached to
data sent across a socket.</p>
<div class="refsect3">
<a name="GstNetControlMessageMeta.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="../html/gstreamer-GstMeta.html#GstMeta"><span class="type">GstMeta</span></a> <em class="structfield"><code><a name="GstNetControlMessageMeta.meta"></a>meta</code></em>;</p></td>
<td class="struct_member_description"><p>the parent type</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gio/GSocketControlMessage.html#GSocketControlMessage-struct"><span class="type">GSocketControlMessage</span></a> *<em class="structfield"><code><a name="GstNetControlMessageMeta.message"></a>message</code></em>;</p></td>
<td class="struct_member_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GSocketControlMessage.html#GSocketControlMessage-struct"><span class="type">GSocketControlMessage</span></a> stored as metadata</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>